////////////////////////////////////////////////////////////////////////////////////////////
//
//  ARInflector.h
// 
////////////////////////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2007, Fjölnir Ásgeirsson
// 
// All rights reserved.
// 
// Redistribution and use in source and binary forms, with or without modification, 
// are permitted provided that the following conditions are met:
// 
// Redistributions of source code must retain the above copyright notice, this list of conditions
// and the following disclaimer.
// Redistributions in binary form must reproduce the above copyright notice, this list of
// conditions and the following disclaimer in the documentation and/or other materials provided with 
// the distribution.
// Neither the name of Fjölnir Ásgeirsson, ninja kitten nor the names of its contributors may be 
// used to endorse or promote products derived from this software without specific prior written permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#ifndef _ARINFLECTOR_H_
#define _ARINFLECTOR_H_

#import <Foundation/Foundation.h>

/*!
 * Provides inflections for english words (can be extended to support other languages
 * by writing a plist configuration for it)
 */
@interface ARInflector : NSObject {
  NSArray *irregulars;
  NSArray *uncountables;
  NSArray *plurals;
  NSArray *singulars;
}
@property(readwrite, retain) NSArray *irregulars, *uncountables, *plurals, *singulars;

/*! Returns the shared inflector object */
+ (ARInflector *)sharedInflector;

/*!
 * Returns a pluralized form of a word, if it's already pluralized no change occurs
 * @param word The word to transform
 */
- (NSString *)pluralizeWord:(NSString *)word;
/*!
 * Returns a singularized form of a word, if it's already singularized no change occurs
 * @param word The word to transform
 */
- (NSString *)singularizeWord:(NSString *)word;
@end
#endif /* _ARINFLECTOR_H_ */
